<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LibDriver DS18B20: example/driver_ds18b20_alarm.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="doxygen.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">LibDriver DS18B20
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">DS18B20 full function driver</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('driver__ds18b20__alarm_8c.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">driver_ds18b20_alarm.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>driver ds18b20 alarm source file  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="driver__ds18b20__alarm_8h_source.html">driver_ds18b20_alarm.h</a>&quot;</code><br />
</div>
<p><a href="driver__ds18b20__alarm_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aceca818b591b2a75bf7587264df98e5a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#aceca818b591b2a75bf7587264df98e5a">ds18b20_alarm_init</a> (void)</td></tr>
<tr class="memdesc:aceca818b591b2a75bf7587264df98e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example init  <a href="driver__ds18b20__alarm_8c.html#aceca818b591b2a75bf7587264df98e5a">More...</a><br /></td></tr>
<tr class="separator:aceca818b591b2a75bf7587264df98e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7386790c80de8807e9f1b7467426f3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#aea7386790c80de8807e9f1b7467426f3">ds18b20_alarm_set_threshold</a> (uint8_t rom[8], float low, float high)</td></tr>
<tr class="memdesc:aea7386790c80de8807e9f1b7467426f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example set the threshold  <a href="driver__ds18b20__alarm_8c.html#aea7386790c80de8807e9f1b7467426f3">More...</a><br /></td></tr>
<tr class="separator:aea7386790c80de8807e9f1b7467426f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af399ae219cf762344c9bcf9af5177636"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#af399ae219cf762344c9bcf9af5177636">ds18b20_alarm_get_threshold</a> (uint8_t rom[8], float *low, float *high)</td></tr>
<tr class="memdesc:af399ae219cf762344c9bcf9af5177636"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example get the threshold  <a href="driver__ds18b20__alarm_8c.html#af399ae219cf762344c9bcf9af5177636">More...</a><br /></td></tr>
<tr class="separator:af399ae219cf762344c9bcf9af5177636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23feb959a6ccf44bfa06138c5ae73319"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#a23feb959a6ccf44bfa06138c5ae73319">ds18b20_alarm_search</a> (uint8_t(*rom)[8], uint8_t *num)</td></tr>
<tr class="memdesc:a23feb959a6ccf44bfa06138c5ae73319"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example find  <a href="driver__ds18b20__alarm_8c.html#a23feb959a6ccf44bfa06138c5ae73319">More...</a><br /></td></tr>
<tr class="separator:a23feb959a6ccf44bfa06138c5ae73319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6872277417e0d85467d391c591d182e0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#a6872277417e0d85467d391c591d182e0">ds18b20_alarm_deinit</a> (void)</td></tr>
<tr class="memdesc:a6872277417e0d85467d391c591d182e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example deinit  <a href="driver__ds18b20__alarm_8c.html#a6872277417e0d85467d391c591d182e0">More...</a><br /></td></tr>
<tr class="separator:a6872277417e0d85467d391c591d182e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>driver ds18b20 alarm source file </p>
<p>Copyright (c) 2015 - present LibDriver All rights reserved</p>
<p>The MIT License (MIT)</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<dl class="section version"><dt>Version</dt><dd>2.0.0 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Shifeng Li </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2021-04-06</dd></dl>
<h3>history</h3>
<table class="doxtable">
<tr>
<th>Date </th><th>Version </th><th>Author </th><th>Description </th></tr>
<tr>
<td>2021/04/06 </td><td>2.0 </td><td>Shifeng Li </td><td>format the code </td></tr>
<tr>
<td>2020/12/20 </td><td>1.0 </td><td>Shifeng Li </td><td>first upload </td></tr>
</table>

<p class="definition">Definition in file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a6872277417e0d85467d391c591d182e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6872277417e0d85467d391c591d182e0">&#9670;&nbsp;</a></span>ds18b20_alarm_deinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ds18b20_alarm_deinit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>alarm example deinit </p>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 deinit failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00210">210</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="af399ae219cf762344c9bcf9af5177636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af399ae219cf762344c9bcf9af5177636">&#9670;&nbsp;</a></span>ds18b20_alarm_get_threshold()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ds18b20_alarm_get_threshold </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rom</em>[8], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>low</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>high</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>alarm example get the threshold </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">*low</td><td>points to a low threshold </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">*high</td><td>points to a high threshold </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 get threshold failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00144">144</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="aceca818b591b2a75bf7587264df98e5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceca818b591b2a75bf7587264df98e5a">&#9670;&nbsp;</a></span>ds18b20_alarm_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ds18b20_alarm_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>alarm example init </p>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 init failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00049">49</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="a23feb959a6ccf44bfa06138c5ae73319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23feb959a6ccf44bfa06138c5ae73319">&#9670;&nbsp;</a></span>ds18b20_alarm_search()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ds18b20_alarm_search </td>
          <td>(</td>
          <td class="paramtype">uint8_t(*)&#160;</td>
          <td class="paramname"><em>rom</em>[8], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>num</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>alarm example find </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">*num</td><td>points to a number buffer </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 search failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00190">190</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="aea7386790c80de8807e9f1b7467426f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7386790c80de8807e9f1b7467426f3">&#9670;&nbsp;</a></span>ds18b20_alarm_set_threshold()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ds18b20_alarm_set_threshold </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rom</em>[8], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>low</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>high</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>alarm example set the threshold </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">low</td><td>is the low threshold </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">high</td><td>is the high threshold </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 set threshold failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00097">97</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html">example</a></li><li class="navelem"><a class="el" href="driver__ds18b20__alarm_8c.html">driver_ds18b20_alarm.c</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
